<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: General</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__scb__uart__general__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">General<div class="ingroups"><a class="el" href="group__group__scb.html">SCB          (Serial Communication Block)</a> &raquo; <a class="el" href="group__group__scb__uart.html">UART (SCB)</a> &raquo; <a class="el" href="group__group__scb__uart__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacbc061f623d2fafbcfffcb58c5f2db51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__scb__uart__enums.html#gac72413306ca26b7b8174526e3fc539df">cy_en_scb_uart_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#gacbc061f623d2fafbcfffcb58c5f2db51">Cy_SCB_UART_Init</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base, <a class="el" href="structcy__stc__scb__uart__config__t.html">cy_stc_scb_uart_config_t</a> const *config, <a class="el" href="structcy__stc__scb__uart__context__t.html">cy_stc_scb_uart_context_t</a> *context)</td></tr>
<tr class="memdesc:gacbc061f623d2fafbcfffcb58c5f2db51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the SCB for UART operation.  <a href="#gacbc061f623d2fafbcfffcb58c5f2db51">More...</a><br /></td></tr>
<tr class="separator:gacbc061f623d2fafbcfffcb58c5f2db51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75294a651a2535fe9fd09af33c726920"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga75294a651a2535fe9fd09af33c726920">Cy_SCB_UART_DeInit</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga75294a651a2535fe9fd09af33c726920"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initializes the SCB block.  <a href="#ga75294a651a2535fe9fd09af33c726920">More...</a><br /></td></tr>
<tr class="separator:ga75294a651a2535fe9fd09af33c726920"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga503d0737dadf35620306ef3571d84905"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga503d0737dadf35620306ef3571d84905">Cy_SCB_UART_Enable</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga503d0737dadf35620306ef3571d84905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the SCB block for the UART operation.  <a href="#ga503d0737dadf35620306ef3571d84905">More...</a><br /></td></tr>
<tr class="separator:ga503d0737dadf35620306ef3571d84905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a07f58f9a898202d43bc3b14caab2de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga2a07f58f9a898202d43bc3b14caab2de">Cy_SCB_UART_Disable</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base, <a class="el" href="structcy__stc__scb__uart__context__t.html">cy_stc_scb_uart_context_t</a> *context)</td></tr>
<tr class="memdesc:ga2a07f58f9a898202d43bc3b14caab2de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the SCB block and clears context statuses.  <a href="#ga2a07f58f9a898202d43bc3b14caab2de">More...</a><br /></td></tr>
<tr class="separator:ga2a07f58f9a898202d43bc3b14caab2de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8624a57785ed01037ac6f713d4965fe4"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga8624a57785ed01037ac6f713d4965fe4">Cy_SCB_UART_EnableCts</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga8624a57785ed01037ac6f713d4965fe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the Clear to Send (CTS) input for the UART.  <a href="#ga8624a57785ed01037ac6f713d4965fe4">More...</a><br /></td></tr>
<tr class="separator:ga8624a57785ed01037ac6f713d4965fe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e8b2b35c2b977ceeaa8d5e2346d80be"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga2e8b2b35c2b977ceeaa8d5e2346d80be">Cy_SCB_UART_DisableCts</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga2e8b2b35c2b977ceeaa8d5e2346d80be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the Clear to Send (CTS) input for the UART.  <a href="#ga2e8b2b35c2b977ceeaa8d5e2346d80be">More...</a><br /></td></tr>
<tr class="separator:ga2e8b2b35c2b977ceeaa8d5e2346d80be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadba62509586aebd21d6e5511abd9e09d"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#gadba62509586aebd21d6e5511abd9e09d">Cy_SCB_UART_SetRtsFifoLevel</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base, uint32_t level)</td></tr>
<tr class="memdesc:gadba62509586aebd21d6e5511abd9e09d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a level for the Ready To Send (RTS) signal activation.  <a href="#gadba62509586aebd21d6e5511abd9e09d">More...</a><br /></td></tr>
<tr class="separator:gadba62509586aebd21d6e5511abd9e09d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae8b7c8a06d34d42aea6e2913da5bebe"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#gaae8b7c8a06d34d42aea6e2913da5bebe">Cy_SCB_UART_GetRtsFifoLevel</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> const *base)</td></tr>
<tr class="memdesc:gaae8b7c8a06d34d42aea6e2913da5bebe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the level in the RX FIFO for the RTS signal activation.  <a href="#gaae8b7c8a06d34d42aea6e2913da5bebe">More...</a><br /></td></tr>
<tr class="separator:gaae8b7c8a06d34d42aea6e2913da5bebe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3374291c2222f5e1e6f043c8f9dbf969"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga3374291c2222f5e1e6f043c8f9dbf969">Cy_SCB_UART_EnableSkipStart</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga3374291c2222f5e1e6f043c8f9dbf969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the skip start-bit functionality.  <a href="#ga3374291c2222f5e1e6f043c8f9dbf969">More...</a><br /></td></tr>
<tr class="separator:ga3374291c2222f5e1e6f043c8f9dbf969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2154a54acbf4e9a5a38af3c515d4acc3"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga2154a54acbf4e9a5a38af3c515d4acc3">Cy_SCB_UART_DisableSkipStart</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga2154a54acbf4e9a5a38af3c515d4acc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the skip start-bit functionality.  <a href="#ga2154a54acbf4e9a5a38af3c515d4acc3">More...</a><br /></td></tr>
<tr class="separator:ga2154a54acbf4e9a5a38af3c515d4acc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67842f041cc8abbda979ee2bac1923c1"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga67842f041cc8abbda979ee2bac1923c1">Cy_SCB_UART_EnableSingleWireHalfDuplex</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga67842f041cc8abbda979ee2bac1923c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables Single Wire Half Duplex Communication.  <a href="#ga67842f041cc8abbda979ee2bac1923c1">More...</a><br /></td></tr>
<tr class="separator:ga67842f041cc8abbda979ee2bac1923c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3e6e60fdc4bd677787d72f2c079f46be"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__general__functions.html#ga3e6e60fdc4bd677787d72f2c079f46be">Cy_SCB_UART_DisableSingleWireHalfDuplex</a> (<a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *base)</td></tr>
<tr class="memdesc:ga3e6e60fdc4bd677787d72f2c079f46be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables Single Wire Half Duplex Communication.  <a href="#ga3e6e60fdc4bd677787d72f2c079f46be">More...</a><br /></td></tr>
<tr class="separator:ga3e6e60fdc4bd677787d72f2c079f46be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gacbc061f623d2fafbcfffcb58c5f2db51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacbc061f623d2fafbcfffcb58c5f2db51">&#9670;&nbsp;</a></span>Cy_SCB_UART_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__scb__uart__enums.html#gac72413306ca26b7b8174526e3fc539df">cy_en_scb_uart_status_t</a> Cy_SCB_UART_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__scb__uart__config__t.html">cy_stc_scb_uart_config_t</a> const *&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__scb__uart__context__t.html">cy_stc_scb_uart_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the SCB for UART operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
    <tr><td class="paramname">config</td><td>The pointer to configuration structure <a class="el" href="structcy__stc__scb__uart__config__t.html">cy_stc_scb_uart_config_t</a>.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__scb__uart__context__t.html">cy_stc_scb_uart_context_t</a> allocated by the user. The structure is used during the UART operation for internal configuration and data retention. The user must not modify anything in this structure. If only UART <a class="el" href="group__group__scb__uart.html#group_scb_uart_ll">Low-Level API</a> will be used pass NULL as pointer to context.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__scb__uart__enums.html#gac72413306ca26b7b8174526e3fc539df">cy_en_scb_uart_status_t</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>Ensure that the SCB block is disabled before calling this function. </dd></dl>

</div>
</div>
<a id="ga75294a651a2535fe9fd09af33c726920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75294a651a2535fe9fd09af33c726920">&#9670;&nbsp;</a></span>Cy_SCB_UART_DeInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SCB_UART_DeInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>De-initializes the SCB block. </p>
<p>Returns the register values to default.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Ensure that the SCB block is disabled before calling this function. </dd></dl>

</div>
</div>
<a id="ga503d0737dadf35620306ef3571d84905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga503d0737dadf35620306ef3571d84905">&#9670;&nbsp;</a></span>Cy_SCB_UART_Enable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_Enable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the SCB block for the UART operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2a07f58f9a898202d43bc3b14caab2de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2a07f58f9a898202d43bc3b14caab2de">&#9670;&nbsp;</a></span>Cy_SCB_UART_Disable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SCB_UART_Disable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__scb__uart__context__t.html">cy_stc_scb_uart_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the SCB block and clears context statuses. </p>
<p>Note that after the block is disabled, the TX and RX FIFOs and hardware statuses are cleared. Also, the hardware stops driving the output and ignores the input. Refer to section <a class="el" href="group__group__scb__uart.html#group_scb_uart_lp">Low Power Support</a> for more information about UART pins when SCB disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__scb__uart__context__t.html">cy_stc_scb_uart_context_t</a> allocated by the user. The structure is used during the UART operation for internal configuration and data retention. The user must not modify anything in this structure. If only UART functions that do not require context will be used to pass NULL as pointer to context.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Calling this function when the UART is busy (transmitter preforms data transfer or receiver is in the middle of data reception) may result transfer corruption because the hardware stops driving the outputs and ignores the inputs. Ensure that the UART is not busy before calling this function. </dd></dl>

</div>
</div>
<a id="ga8624a57785ed01037ac6f713d4965fe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8624a57785ed01037ac6f713d4965fe4">&#9670;&nbsp;</a></span>Cy_SCB_UART_EnableCts()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_EnableCts </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the Clear to Send (CTS) input for the UART. </p>
<p>The UART will not transmit data while this signal is inactive.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2e8b2b35c2b977ceeaa8d5e2346d80be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e8b2b35c2b977ceeaa8d5e2346d80be">&#9670;&nbsp;</a></span>Cy_SCB_UART_DisableCts()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_DisableCts </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the Clear to Send (CTS) input for the UART. </p>
<p>See <a class="el" href="group__group__scb__uart__general__functions.html#ga8624a57785ed01037ac6f713d4965fe4">Cy_SCB_UART_EnableCts</a> for the details.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gadba62509586aebd21d6e5511abd9e09d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadba62509586aebd21d6e5511abd9e09d">&#9670;&nbsp;</a></span>Cy_SCB_UART_SetRtsFifoLevel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_SetRtsFifoLevel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>level</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets a level for the Ready To Send (RTS) signal activation. </p>
<p>When the number of data elements in the receive FIFO is below this level, then the RTS output is active. Otherwise, the RTS signal is inactive. To disable the RTS signal generation, set this level to zero.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
    <tr><td class="paramname">level</td><td>The level in the RX FIFO for RTS signal activation. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaae8b7c8a06d34d42aea6e2913da5bebe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae8b7c8a06d34d42aea6e2913da5bebe">&#9670;&nbsp;</a></span>Cy_SCB_UART_GetRtsFifoLevel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_SCB_UART_GetRtsFifoLevel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the level in the RX FIFO for the RTS signal activation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The level in the RX FIFO for RTS signal activation. </dd></dl>

</div>
</div>
<a id="ga3374291c2222f5e1e6f043c8f9dbf969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3374291c2222f5e1e6f043c8f9dbf969">&#9670;&nbsp;</a></span>Cy_SCB_UART_EnableSkipStart()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_EnableSkipStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the skip start-bit functionality. </p>
<p>When skip start is enabled the UART hardware does not synchronize to a start bit but synchronizes to the first rising edge. To create a rising edge, the first data bit must be a 1. This feature is useful when the start bit falling edge is used to wake the device through a GPIO interrupt.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>When skip start-bit feature is enabled, it is applied (UART synchronizes to the first rising edge after start bit) whenever the SCB is enabled. This can cause incorrect UART synchronization and data reception when the first data bit is not a 1. Therefore, disable the skip start-bit when it should not be applied. Note that SCB is disabled before enter Deep Sleep mode or after calling <a class="el" href="group__group__scb__uart__general__functions.html#ga2a07f58f9a898202d43bc3b14caab2de">Cy_SCB_UART_Disable</a>. </dd></dl>

</div>
</div>
<a id="ga2154a54acbf4e9a5a38af3c515d4acc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2154a54acbf4e9a5a38af3c515d4acc3">&#9670;&nbsp;</a></span>Cy_SCB_UART_DisableSkipStart()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_DisableSkipStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable the skip start-bit functionality. </p>
<p>See <a class="el" href="group__group__scb__uart__general__functions.html#ga3374291c2222f5e1e6f043c8f9dbf969">Cy_SCB_UART_EnableSkipStart</a> for the details.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga67842f041cc8abbda979ee2bac1923c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga67842f041cc8abbda979ee2bac1923c1">&#9670;&nbsp;</a></span>Cy_SCB_UART_EnableSingleWireHalfDuplex()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_EnableSingleWireHalfDuplex </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables Single Wire Half Duplex Communication. </p>
<dl class="section note"><dt>Note</dt><dd>This is applicable in standard UART submode only.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for PSoC C3 (CAT1B) devices. </dd></dl>

</div>
</div>
<a id="ga3e6e60fdc4bd677787d72f2c079f46be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3e6e60fdc4bd677787d72f2c079f46be">&#9670;&nbsp;</a></span>Cy_SCB_UART_DisableSingleWireHalfDuplex()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_SCB_UART_DisableSingleWireHalfDuplex </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_cy_s_c_b___type.html">CySCB_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables Single Wire Half Duplex Communication. </p>
<dl class="section note"><dt>Note</dt><dd>This is applicable in standard UART submode only.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the UART SCB instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for PSoC C3 (CAT1B) devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
